/*
 * Copyright (c) 1997, 2013, Oracle and/or its affiliates. All rights reserved.
 * ORACLE PROPRIETARY/CONFIDENTIAL. Use is subject to license terms.
 *
 *
 *
 *
 *
 *
 *
 *
 *
 *
 *
 *
 *
 *
 *
 *
 *
 *
 *
 *
 */

package java.util;

import java.util.function.Consumer;

/**
 * Doubly-linked list implementation of the {@code List} and {@code Deque}
 * interfaces.  Implements all optional list operations, and permits all
 * elements (including {@code null}).
 *
 * <p>All of the operations perform as could be expected for a doubly-linked
 * list.  Operations that index into the list will traverse the list from
 * the beginning or the end, whichever is closer to the specified index.
 *
 * <p><strong>Note that this implementation is not synchronized.</strong>
 * If multiple threads access a linked list concurrently, and at least
 * one of the threads modifies the list structurally, it <i>must</i> be
 * synchronized externally.  (A structural modification is any operation
 * that adds or deletes one or more elements; merely setting the value of
 * an element is not a structural modification.)  This is typically
 * accomplished by synchronizing on some object that naturally
 * encapsulates the list.
 * <p>
 * If no such object exists, the list should be "wrapped" using the
 * {@link Collections#synchronizedList Collections.synchronizedList}
 * method.  This is best done at creation time, to prevent accidental
 * unsynchronized access to the list:<pre>
 *   List list = Collections.synchronizedList(new LinkedList(...));</pre>
 *
 * <p>The iterators returned by this class's {@code iterator} and
 * {@code listIterator} methods are <i>fail-fast</i>: if the list is
 * structurally modified at any time after the iterator is created, in
 * any way except through the Iterator's own {@code remove} or
 * {@code add} methods, the iterator will throw a {@link
 * ConcurrentModificationException}.  Thus, in the face of concurrent
 * modification, the iterator fails quickly and cleanly, rather than
 * risking arbitrary, non-deterministic behavior at an undetermined
 * time in the future.
 *
 * <p>Note that the fail-fast behavior of an iterator cannot be guaranteed
 * as it is, generally speaking, impossible to make any hard guarantees in the
 * presence of unsynchronized concurrent modification.  Fail-fast iterators
 * throw {@code ConcurrentModificationException} on a best-effort basis.
 * Therefore, it would be wrong to write a program that depended on this
 * exception for its correctness:   <i>the fail-fast behavior of iterators
 * should be used only to detect bugs.</i>
 *
 * <p>This class is a member of the
 * <a href="{@docRoot}/../technotes/guides/collections/index.html">
 * Java Collections Framework</a>.
 *
 * @param <E> the type of elements held in this collection
 * @author Josh Bloch
 * @see List
 * @see ArrayList
 * @since 1.2
 */

public class LinkedList<E>
        extends AbstractSequentialList<E>
        implements List<E>, Deque<E>, Cloneable, java.io.Serializable {

    /**
     * 集合长度
     */
    transient int size = 0;

    /**
     * 集合第一个节点
     */
    transient Node<E> first;

    /**
     * 集合最后一个节点
     */
    transient Node<E> last;

    /**
     * 无参构造
     */
    public LinkedList() {
    }

    /**
     * 创建包含指定元素的集合
     *
     * @param c the collection whose elements are to be placed into this list
     * @throws NullPointerException if the specified collection is null
     */
    public LinkedList(Collection<? extends E> c) {
        // 调用无参构造创建集合
        this();
        // 调用addAll方法把数据加入结婚
        addAll(c);
    }

    /**
     * 将制定数据作为集合第一个节点
     */
    private void linkFirst(E e) {
        final Node<E> f = first;
        final Node<E> newNode = new Node<>(null, e, f);
        first = newNode;
        if (f == null)
            last = newNode;
        else
            f.prev = newNode;
        size++;
        modCount++;
    }

    /**
     * 插入最后一个元素
     */
    void linkLast(E e) {
        // 最后一个元素
        final Node<E> l = last;
        // 新节点
        final Node<E> newNode = new Node<>(l, e, null);
        // 修改最后一个节点
        last = newNode;
        // 判断最后一个节点是否为null
        if (l == null)
            // 如果为null 表示为第一个节点
            first = newNode;
        else
            // 否则之前最后一个节点的下一个节点为当前节点
            l.next = newNode;
        // 修改长度
        size++;
        // 修改修改值
        modCount++;
    }

    /**
     * 在指定接点插入新元素
     */
    void linkBefore(E e, Node<E> succ) {
        // assert succ != null;
        // 上一个节点
        final Node<E> pred = succ.prev;
        // 新节点
        final Node<E> newNode = new Node<>(pred, e, succ);
        // 指定接点上一个节点为新节点
        succ.prev = newNode;
        if (pred == null)
            // 上一个节点元素为null 新节点为第一个元素
            first = newNode;
        else
            // 上一个节点的下一个节点为新节点
            pred.next = newNode;
        // 修改集合长度
        size++;
        // 修改修改值
        modCount++;
    }

    /**
     * 删除首节点数据
     */
    private E unlinkFirst(Node<E> f) {
        // assert f == first && f != null;
        // 获取首节点
        final E element = f.item;
        // 获取首节点的下一个指向节点
        final Node<E> next = f.next;
        // 首节点数据设置为null
        f.item = null;
        // 首节点下一个节点指向设置为null
        f.next = null; // help GC
        // 首节点为原首节点的下一个节点
        first = next;
        if (next == null)
        // 新的首节点为null 即集合只有一个首节点且被删除 此时集合长度为0 尾节点也设置为null
            last = null;
        else
            // 修改新的首节点上一个节点指向
            next.prev = null;
        // 集合长度
        size--;
        // 修改值
        modCount++;
        return element;
    }

    /**
     * 删除尾节点
     */
    private E unlinkLast(Node<E> l) {
        // assert l == last && l != null;
        // 获取尾节点数据
        final E element = l.item;
        // 获取尾节点上一个节点指向
        final Node<E> prev = l.prev;
        // 尾节点数据设置为null
        l.item = null;
        // 尾节点上一个节点指向设置为null
        l.prev = null; // help GC
        // 修改尾节点
        last = prev;
        if (prev == null)
        // 新的尾节点为null 即集合只有一个首节点且被删除 此时集合长度为0 首节点也设置为null
            first = null;
        else
            // 新的尾节点下一个指向设置为null
            prev.next = null;
        // 集合长度
        size--;
        // 修改修改值
        modCount++;
        return element;
    }

    /**
     * 删除节点
     */
    E unlink(Node<E> x) {
        // assert x != null;
        // 获取数据
        final E element = x.item;
        // 下一个节点
        final Node<E> next = x.next;
        // 上一个节点
        final Node<E> prev = x.prev;


        if (prev == null) {
            // 上一个节点为null 删除节为首节点 删除之后首节点为删除节点的下一个节点
            first = next;
        } else {
            // 删除节点的上一个节点的next指向删除节点的下一个节点
            prev.next = next;
            // 删除节点上一个节点设置为null
            x.prev = null;
        }

        if (next == null) {
            // 下一个节点为null 删除节为尾节点 删除之后尾节点为删除节点的上一个节点
            last = prev;
        } else {
            // 删除节点的下一个节点的prev指向删除节点的上一个节点
            next.prev = prev;
            // 删除节点下一个节点设置为null
            x.next = null;
        }
        // 删除几点数据
        x.item = null;
        // 集合长度修改
        size--;
        // 修改修改值
        modCount++;
        // 返回删除数据
        return element;
    }

    /**
     * 获取集合中的第一个元素
     *
     * @return the first element in this list
     * @throws NoSuchElementException 如果集合是空的
     */
    public E getFirst() {
        // 获取第一个节点
        final Node<E> f = first;
        // 判断节点是否为空
        if (f == null)
            throw new NoSuchElementException();
        // 获取节点数据
        return f.item;
    }

    /**
     * 获取最后一个元素
     *
     * @return the last element in this list
     * @throws NoSuchElementException 如果集合是空的
     */
    public E getLast() {
        // 获取最后一个节点
        final Node<E> l = last;
        // 判断节点是否为空
        if (l == null)
            throw new NoSuchElementException();
        // 获取节点数据
        return l.item;
    }

    /**
     * 删除集合第一个数据
     *
     * @return the first element from this list
     * @throws NoSuchElementException if this list is empty
     */
    public E removeFirst() {
        // 获取首节点
        final Node<E> f = first;
        if (f == null)
            throw new NoSuchElementException();
        // 删除
        return unlinkFirst(f);
    }

    /**
     * 删除集合最后一个元素
     *
     * @return the last element from this list
     * @throws NoSuchElementException if this list is empty
     */
    public E removeLast() {
        // 获取最后一个元素
        final Node<E> l = last;
        // 判空
        if (l == null)
            throw new NoSuchElementException();
        // 删除元素并返回
        return unlinkLast(l);
    }

    /**
     * 在集合首位添加一个元素
     *
     * @param e 添加的元素
     */
    public void addFirst(E e) {
        linkFirst(e);
    }

    /**
     * 在集合末位添加一个元素
     * 这个方法和{@link #add}功能一样
     *
     * @param e 添加的元素
     */
    public void addLast(E e) {
        linkLast(e);
    }

    /**
     * 集合是否包含指定元素
     *
     * @param o 指定元素
     * @return
     */
    public boolean contains(Object o) {
        return indexOf(o) != -1;
    }

    /**
     * 获取集合的长度
     *
     * @return 集合长度
     */
    public int size() {
        return size;
    }

    /**
     * 在集合末尾添加元素
     * 功能和{@link #addLast}相似 两者都是调用linkLast
     * 区别在于返回值
     *
     * @param e element to be appended to this list
     * @return {@code true} (as specified by {@link Collection#add})
     */
    public boolean add(E e) {
        linkLast(e);
        return true;
    }

    /**
     * 删除第一次出现指定元素的位置
     *
     * @param o element to be removed from this list, if present
     * @return {@code true} if this list contained the specified element
     */
    public boolean remove(Object o) {
        if (o == null) {
            // 如果指定元素为null
            for (Node<E> x = first; x != null; x = x.next) {
                //  循环判断集合中的数据是否为null
                if (x.item == null) {
                    // 删除节点
                    unlink(x);
                    return true;
                }
            }
        } else {
            // 如果指定元素不为null
            for (Node<E> x = first; x != null; x = x.next) {
                //  循环判断集合中的数据和指定数据是否相同
                if (o.equals(x.item)) {
                    // 删除节点
                    unlink(x);
                    return true;
                }
            }
        }
        return false;
    }

    /**
     * 将指定集合中的元素添加到该集合中
     *
     * @param c 指定集合
     * @return {@code true} if this list changed as a result of the call
     * @throws NullPointerException 指定集合为null
     */
    public boolean addAll(Collection<? extends E> c) {
        return addAll(size, c);
    }

    /**
     * 在指定位置插入指定集合中的元素，指定位置之后的元素全部后移
     *
     * @param index 指定位置
     * @param c     指定集合
     * @return {@code true} if this list changed as a result of the call
     * @throws IndexOutOfBoundsException {@inheritDoc}
     * @throws NullPointerException      if the specified collection is null
     */
    public boolean addAll(int index, Collection<? extends E> c) {
        // 检查集合位置是否合理
        checkPositionIndex(index);

        // 添加集合转添加数组
        Object[] a = c.toArray();
        // 添加数组长度
        int numNew = a.length;
        if (numNew == 0)
            return false;
        // pred  上一个元素  succ // 后一个元素
        Node<E> pred, succ;
        if (index == size) {
            succ = null;
            pred = last;
        } else {
            // 获取当前位置的节点
            succ = node(index);
            // 获取当前位置之前的节点
            pred = succ.prev;
        }

        // 循环添加数组数据
        for (Object o : a) {
            @SuppressWarnings("unchecked") E e = (E) o;
            // 创建新节点
            Node<E> newNode = new Node<>(pred, e, null);
            if (pred == null)
                // 上个节点为null 新节点为开始节点
                first = newNode;
            else
                //否则就在上一个节点下添加元素
                pred.next = newNode;
            // 将新节点设置为上一个节点
            pred = newNode;
        }
        if (succ == null) {
            // 传入时当前位置节点为null
            // 最后一个节点为 最后添加的一个节点
            last = pred;
        } else {
            // 最后添加下一个节点为传入时当前位置节点
            pred.next = succ;
            // 传入时当前位置节点的上一个节点为最后一个添加节点
            succ.prev = pred;
        }

        // 更改集合长度
        size += numNew;
        // 修改修改值
        modCount++;
        return true;
    }

    /**
     * 清空集合中的全部元素
     */
    public void clear() {

        // 开始为first 循环终止x为null
        for (Node<E> x = first; x != null; ) {
            // 获取下一个节点
            Node<E> next = x.next;
            // 节点元素的值为null
            x.item = null;
            // 节点指向的下一个的元素为设置为null
            x.next = null;
            // 节点指向的上一个元素为null
            x.prev = null;
            // 节点赋值 进行下次循环
            x = next;
        }
        // 首节点和尾节点设置为null
        first = last = null;
        // 集合长度设置为0
        size = 0;
        // 修改集合修改值
        modCount++;
    }


    // Positional Access Operations

    /**
     * 获取指定位置的元素
     *
     * @param index 制定位置
     * @return the element at the specified position in this list
     * @throws IndexOutOfBoundsException 指定位置小于0或者超过集合大小
     */
    public E get(int index) {
        // 检查位置合法
        checkElementIndex(index);
        // 获取指定位置节点的元素
        return node(index).item;
    }

    /**
     * 修改指定节点位置的元素
     *
     * @param index   index of the element to replace
     * @param element element to be stored at the specified position
     * @return the element previously at the specified position
     * @throws IndexOutOfBoundsException {@inheritDoc}
     */
    public E set(int index, E element) {
        // 检查位置
        checkElementIndex(index);
        // 获取节点
        Node<E> x = node(index);
        // 获取节点原始值
        E oldVal = x.item;
        // 修改节点值
        x.item = element;
        return oldVal;
    }

    /**
     * 在指定位置添加一个元素
     *
     * @param index   指定位置
     * @param element 插入元素
     * @throws IndexOutOfBoundsException {@inheritDoc}
     */
    public void add(int index, E element) {
        // 检查位置合法性
        checkPositionIndex(index);

        if (index == size)
            // 如果位置和集合长度一样直接在最后插入
            linkLast(element);
        else
            // 否则就在指定位置那个元素之前插入数据
            linkBefore(element, node(index));
    }

    /**
     * 删除固定位置的元素
     *
     * @param index the index of the element to be removed
     * @return the element previously at the specified position
     * @throws IndexOutOfBoundsException {@inheritDoc}
     */
    public E remove(int index) {
        // 检查位置
        checkElementIndex(index);
        // 获取并删除节点
        return unlink(node(index));
    }

    /**
     * 判断指定下标是否在集合内
     */
    private boolean isElementIndex(int index) {
        // 指定小标大于等于0且小于集合长度
        return index >= 0 && index < size;
    }

    /**
     * 制定位置大于等于0且小于集合长度
     */
    private boolean isPositionIndex(int index) {
        return index >= 0 && index <= size;
    }

    /**
     * 绑定一行信息
     */
    private String outOfBoundsMsg(int index) {
        return "Index: " + index + ", Size: " + size;
    }

    /**
     * 检查指定下标
     *
     * @param index 指定下标
     */
    private void checkElementIndex(int index) {
        if (!isElementIndex(index))
            throw new IndexOutOfBoundsException(outOfBoundsMsg(index));
    }

    /**
     * 检测集合的位置是否合理
     *
     * @param index
     */
    private void checkPositionIndex(int index) {
        if (!isPositionIndex(index))
            throw new IndexOutOfBoundsException(outOfBoundsMsg(index));
    }

    /**
     * 获取指定节点的元素
     */
    Node<E> node(int index) {
        // assert isElementIndex(index);
        // 使用>> 进行判断从开始进行查，还是从结束开始查数据

        if (index < (size >> 1)) {
            Node<E> x = first;
            // 循环获取下一个元素
            for (int i = 0; i < index; i++)
                x = x.next;
            return x;
        } else {
            Node<E> x = last;
            // 循环获取上一个元素
            for (int i = size - 1; i > index; i--)
                x = x.prev;
            return x;
        }
    }

    // Search Operations

    /**
     * 获取指定元素第一次出现的位置
     *
     * @param o 指定元素
     * @return 元素第一次出现的位置 如果不存在返回为-1
     */
    public int indexOf(Object o) {
        int index = 0;
        if (o == null) {
            // 指定元素为null
            for (Node<E> x = first; x != null; x = x.next) {
                // 循环遍历查看元素是否为null
                if (x.item == null)
                    return index;
                index++;
            }
        } else {
            // 指定元素不为null
            for (Node<E> x = first; x != null; x = x.next) {
                // 循环遍历查看元素是否和指定元素相同（equals）
                if (o.equals(x.item))
                    return index;
                index++;
            }
        }
        return -1;
    }

    /**
     * 获取指定元素最后一个出现的位置
     *
     * @param o 指定元素
     * @return 指定元素的位置，-1表示不存在
     */
    public int lastIndexOf(Object o) {
        // 集合的长度
        int index = size;
        if (o == null) {
            // 指定元素为null 循环遍历数据判断数据是否为null
            for (Node<E> x = last; x != null; x = x.prev) {
                index--;
                if (x.item == null)
                    return index;
            }
        } else {
            // 指定元素为null 循环遍历数据判断数据是否相同（equals）
            for (Node<E> x = last; x != null; x = x.prev) {
                index--;
                if (o.equals(x.item))
                    return index;
            }
        }
        return -1;
    }

    // Queue operations.

    /**
     * 获取集合第一个元素《不会删除》
     *
     * @return the head of this list, or {@code null} if this list is empty
     * @since 1.5
     */
    public E peek() {
        // 获取手首节点
        final Node<E> f = first;
        // 获取首节点元素
        return (f == null) ? null : f.item;
    }

    /**
     * 获取第一个元素数据
     *
     * @return the head of this list
     * @throws NoSuchElementException 列表为空
     * @since 1.5
     */
    public E element() {
        return getFirst();
    }

    /**
     * 获取并删除第一个元素
     *
     * @return the head of this list, or {@code null} if this list is empty
     * @since 1.5
     */
    public E poll() {
        // 获取首节点
        final Node<E> f = first;
        // 获取并删除首节点元素
        return (f == null) ? null : unlinkFirst(f);
    }

    /**
     * 删除第一个元素
     *
     * @return the head of this list
     * @throws NoSuchElementException if this list is empty
     * @since 1.5
     */
    public E remove() {
        return removeFirst();
    }

    /**
     * 在集合尾部添加一个元素
     * 和add(E)功能相同 事实上他也是直接调用了add(E)方法
     *
     * @param e the element to add
     * @return {@code true} (as specified by {@link Queue#offer})
     * @since 1.5
     */
    public boolean offer(E e) {
        return add(e);
    }

    // Deque operations

    /**
     * 在集合头部插入一个元素
     *
     * @param e the element to insert
     * @return {@code true} (as specified by {@link Deque#offerFirst})
     * @since 1.6
     */
    public boolean offerFirst(E e) {
        addFirst(e);
        return true;
    }

    /**
     * 在集合尾部添加衣蛾元素
     *
     * @param e the element to insert
     * @return {@code true} (as specified by {@link Deque#offerLast})
     * @since 1.6
     */
    public boolean offerLast(E e) {
        addLast(e);
        return true;
    }

    /**
     * 获取集合第一个元素《不会删除》
     *
     * @return the first element of this list, or {@code null}
     * if this list is empty
     * @since 1.6
     */
    public E peekFirst() {
        // 获取手首节点
        final Node<E> f = first;
        // 获取首节点元素
        return (f == null) ? null : f.item;
    }

    /**
     * 获取集合最后一个元素《不会删除》
     *
     * @return the last element of this list, or {@code null}
     * if this list is empty
     * @since 1.6
     */
    public E peekLast() {
        // 获取尾节点
        final Node<E> l = last;
        // 获取尾节点元素
        return (l == null) ? null : l.item;
    }

    /**
     * 获取首节点元素（删除）
     *
     * @return the first element of this list, or {@code null} if
     * this list is empty
     * @since 1.6
     */
    public E pollFirst() {
        // 获取首节点
        final Node<E> f = first;
        // 获取并删除首节点元素
        return (f == null) ? null : unlinkFirst(f);
    }

    /**
     * 获取尾节点元素（删除）
     *
     * @return the last element of this list, or {@code null} if
     * this list is empty
     * @since 1.6
     */
    public E pollLast() {
        // 获取尾节点元素
        final Node<E> l = last;
        // 获取并删除尾节点元素
        return (l == null) ? null : unlinkLast(l);
    }

    /**
     * 在集合首位添加一个元素
     * 此方法和{@link #addFirst}相同
     *
     * @param e the element to push
     * @since 1.6
     */
    public void push(E e) {
        addFirst(e);
    }

    /**
     * 获取首节点元素（删除）
     * 如果集合为空集合会抛出NoSuchElementException
     * 功能和removeFirst一致
     *
     * @return the element at the front of this list (which is the top
     * of the stack represented by this list)
     * @throws NoSuchElementException if this list is empty
     * @since 1.6
     */
    public E pop() {
        return removeFirst();
    }

    /**
     * 删除第一次出现指定元素的位置
     *
     * @param o 定元素
     * @return 列表包含指定元素
     * @since 1.6
     */
    public boolean removeFirstOccurrence(Object o) {
        return remove(o);
    }

    /**
     * 删除最后一次出现的指定元素
     *
     * @param o 指定元素
     * @return 集合包含指定元素
     * @since 1.6
     */
    public boolean removeLastOccurrence(Object o) {
        if (o == null) {
            //指定元素为null
            for (Node<E> x = last; x != null; x = x.prev) {
                // 循环判断节点元素是否为null
                if (x.item == null) {
                    // 删除节点
                    unlink(x);
                    return true;
                }
            }
        } else {
            //指定元素不为null
            for (Node<E> x = last; x != null; x = x.prev) {
                // 循环判断节点元素和指定元素是否相同
                if (o.equals(x.item)) {
                    // 删除节点
                    unlink(x);
                    return true;
                }
            }
        }
        return false;
    }

    /**
     * 从指定位置开始获取集合数组迭代器
     * 如果在迭代器创建之后，调用了集合的add或者remove方法会执行fail-fast策略。抛出ConcurrentModificationException
     *
     * @param index 列表迭代器开始位置
     * @return a
     * @throws IndexOutOfBoundsException 指定位置不合法
     * @see List#listIterator(int)
     */
    public ListIterator<E> listIterator(int index) {
        // 位置检查
        checkPositionIndex(index);
        // 创建列表迭代器
        return new ListItr(index);
    }

    /**
     * 列表迭代器实现
     */
    private class ListItr implements ListIterator<E> {
        // 上一次返回节点
        private Node<E> lastReturned;
        // 下一个节点
        private Node<E> next;
        // 下一个节点位置
        private int nextIndex;
        // 预期修改值
        private int expectedModCount = modCount;

        // 构造函数
        ListItr(int index) {
            // 下一个节点
            next = (index == size) ? null : node(index);
            // 下一个节点位置
            nextIndex = index;
        }

        // 是否由下一个元素
        public boolean hasNext() {
            // 下一个节点位置小于集合长度
            return nextIndex < size;
        }

        // 获取元素
        public E next() {
            // 检查修改
            checkForComodification();
            // 是否有下一个元素
            if (!hasNext())
                throw new NoSuchElementException();

            // 修改最后一次返回节点
            lastReturned = next;
            // 修改下一个访问节点
            next = next.next;
            // 下一个节点位置修改
            nextIndex++;
            // 获取节点元素
            return lastReturned.item;
        }

        /**
         * 是否又上一个元素
         */
        public boolean hasPrevious() {
            return nextIndex > 0;
        }

        // 获取上一个元素
        public E previous() {
            // 检查修改
            checkForComodification();
            // 是否有上一个元素
            if (!hasPrevious())
                throw new NoSuchElementException();

            // 如果next是null节点为最后一个节点 否则为next的上一个节点 lastReturned也是next
            lastReturned = next = (next == null) ? last : next.prev;
            // 下一个小标--
            nextIndex--;
            // 获取节点元素
            return lastReturned.item;
        }

        // 下一个元素位置
        public int nextIndex() {
            return nextIndex;
        }

        // 上一个元素位置
        public int previousIndex() {
            return nextIndex - 1;
        }

        // 删除
        public void remove() {
            // 检查修改
            checkForComodification();
            // 上一次返回节点是否为null
            if (lastReturned == null)
                throw new IllegalStateException();
            // 获取上一次返回节点的下一个元素
            Node<E> lastNext = lastReturned.next;
            // 删除节点数据
            unlink(lastReturned);
            if (next == lastReturned)
                // 调用previous后会出现next == lastReturned 此时修改next
                next = lastNext;
            else
                // 调用next 下一次位置减1
                nextIndex--;
            // 修改上一次返回值
            lastReturned = null;
            expectedModCount++;
        }

        // 设置上一次返回的值
        public void set(E e) {
            // 验证上一次返回
            if (lastReturned == null)
                throw new IllegalStateException();
            // 修改检查
            checkForComodification();
            // 修改数据
            lastReturned.item = e;
        }

        // 在上一返回位置添加一个数据
        public void add(E e) {
            // 修改检查
            checkForComodification();
            // 上一次返回节点设置为null
            lastReturned = null;
            // 下一个节点为null 则是尾节点
            if (next == null)
                // 在尾节点添加元素
                linkLast(e);
            else
                // 在下一个节点之前添加元素
                linkBefore(e, next);
            // 下一个位置
            nextIndex++;
            expectedModCount++;
        }

        /**
         * 循环执行操作
         *
         * @param action
         */
        public void forEachRemaining(Consumer<? super E> action) {
            Objects.requireNonNull(action);
            // 循环执行操作
            while (modCount == expectedModCount && nextIndex < size) {
                //  执行操作
                action.accept(next.item);
                // 修改上一次返回节点
                lastReturned = next;
                // 修改下一次访问节点
                next = next.next;
                // 修改下一个下标
                nextIndex++;
            }
            // 检查修改
            checkForComodification();
        }

        /**
         * 修改检查
         */
        final void checkForComodification() {
            if (modCount != expectedModCount)
                throw new ConcurrentModificationException();
        }
    }

    private static class Node<E> {
        // 数据
        E item;
        // 下一个数据
        Node<E> next;
        // 上一个数据
        Node<E> prev;

        Node(Node<E> prev, E element, Node<E> next) {
            this.item = element;
            this.next = next;
            this.prev = prev;
        }
    }

    /**
     * 获取集合反向迭代器
     *
     * @since 1.6
     */
    public Iterator<E> descendingIterator() {
        return new DescendingIterator();
    }

    /**
     * 反向迭代器 即从尾部开始的迭代器
     */
    private class DescendingIterator implements Iterator<E> {
        // 反向迭代器的实现是ListIterator的实现ListItr
        // ListIterator支持正向遍历和反向遍历
        // 反向迭代器的实现 是通过其反向遍历实现的
        private final ListItr itr = new ListItr(size());

        /**
         * 是否由下一个元素
         *
         * @return
         */
        public boolean hasNext() {
            // 调用ListItr的hasPrevious
            return itr.hasPrevious();
        }

        /**
         * 获取下一个元素
         *
         * @return
         */
        public E next() {
            // 调用ListItr的previous
            return itr.previous();
        }

        /**
         * 删除元素
         */
        public void remove() {
            // 调用ListItr的remove
            itr.remove();
        }
    }

    @SuppressWarnings("unchecked")
    private LinkedList<E> superClone() {
        try {
            // 调用Object.clone
            return (LinkedList<E>) super.clone();
        } catch (CloneNotSupportedException e) {
            throw new InternalError(e);
        }
    }

    /**
     * 拷贝一个集合
     *
     * @return a shallow copy of this {@code LinkedList} instance
     */
    public Object clone() {
        // 调用Object.clone
        LinkedList<E> clone = superClone();

        // 把拷贝的集合设置为初始状态
        // 首节点和尾节点设置为null
        clone.first = clone.last = null;
        // 集合长度设置为0
        clone.size = 0;
        // 修改次数设置为0
        clone.modCount = 0;

        // 调用add添加元素<元素的对象害还是相同的>
        for (Node<E> x = first; x != null; x = x.next)
            clone.add(x.item);

        return clone;
    }

    /**
     * 获取集合数据的元素
     *
     * @return an array containing all of the elements in this list
     * in proper sequence
     */
    public Object[] toArray() {
        // 创建数组
        Object[] result = new Object[size];
        int i = 0;
        // 循环集合数组赋值
        for (Node<E> x = first; x != null; x = x.next)
            result[i++] = x.item;
        return result;
    }

    /**
     * 按照指定数组类型返回集合中的数据
     *
     * @param a 指定类型数组
     * @return an array containing the elements of the list
     * @throws ArrayStoreException  集合中数据和数据类型不一致
     * @throws NullPointerException 指定数组为null
     */
    @SuppressWarnings("unchecked")
    public <T> T[] toArray(T[] a) {
        if (a.length < size)
            // 如果指定数组大小小于集合大小
            // 创建一个新的数组
            a = (T[]) java.lang.reflect.Array.newInstance(
                    a.getClass().getComponentType(), size);
        int i = 0;
        Object[] result = a;
        // 循环集合添加数组数据
        for (Node<E> x = first; x != null; x = x.next)
            result[i++] = x.item;

        // 如果数组长度超过集合大小以null区分
        if (a.length > size)
            a[size] = null;

        return a;
    }

    private static final long serialVersionUID = 876323262645176354L;

    /**
     * 将数据写到流中 序列化
     *
     * @serialData The size of the list (the number of elements it
     * contains) is emitted (int), followed by all of its
     * elements (each an Object) in the proper order.
     */
    private void writeObject(java.io.ObjectOutputStream s)
            throws java.io.IOException {
        // Write out any hidden serialization magic
        s.defaultWriteObject();

        // Write out size
        // 写集合长度
        s.writeInt(size);

        // Write out all elements in the proper order.
        // 写集合数据
        for (Node<E> x = first; x != null; x = x.next)
            s.writeObject(x.item);
    }

    /**
     * 从流中读取数据 反序列化
     */
    @SuppressWarnings("unchecked")
    private void readObject(java.io.ObjectInputStream s)
            throws java.io.IOException, ClassNotFoundException {
        // Read in any hidden serialization magic
        // 读取集合默认信息
        s.defaultReadObject();

        // Read in size
        // 获取结合长度
        int size = s.readInt();

        // Read in all elements in the proper order.
        // 循环数据 将数据加入集合中
        for (int i = 0; i < size; i++)
            linkLast((E) s.readObject());
    }

    /**
     * 获取集合列表迭代器 此迭代器遵循fail-fast策略
     *
     * @return a {@code Spliterator} over the elements in this list
     * @implNote The {@code Spliterator} additionally reports {@link Spliterator#SUBSIZED}
     * and implements {@code trySplit} to permit limited parallelism..
     * @since 1.8
     */
    @Override
    public Spliterator<E> spliterator() {
        return new LLSpliterator<E>(this, -1, 0);
    }

    /**
     * A customized variant of Spliterators.IteratorSpliterator
     */
    static final class LLSpliterator<E> implements Spliterator<E> {
        // 批量处理大小增量
        static final int BATCH_UNIT = 1 << 10;  // batch array size increment
        // 最大批量数
        static final int MAX_BATCH = 1 << 25;  // max batch array size;
        // 集合
        final LinkedList<E> list; // null OK unless traversed
        // 当前节点
        Node<E> current;      // current node; null until initialized
        // 估计尺寸
        int est;              // size estimate; -1 until first needed
        // 期望修改值
        int expectedModCount; // initialized when est set
        // 拆分批量位置
        int batch;            // batch size for splits

        // 构造函数
        LLSpliterator(LinkedList<E> list, int est, int expectedModCount) {
            this.list = list;
            this.est = est;
            this.expectedModCount = expectedModCount;
        }

        // 获取估计大小
        final int getEst() {
            int s; // force initialization
            final LinkedList<E> lst;
            if ((s = est) < 0) {
                // 目前估计大小小于0
                if ((lst = list) == null)
                    // 结合为null是 估计大小为0
                    s = est = 0;
                else {
                    // 期望修改值
                    expectedModCount = lst.modCount;
                    // 当前节点为集合首节点
                    current = lst.first;
                    // 获取估计大小为集合长度
                    s = est = lst.size;
                }
            }
            return s;
        }

        // 获取集合估计大小
        public long estimateSize() {
            return (long) getEst();
        }

        // 尝试对集合进行分割
        public Spliterator<E> trySplit() {
            Node<E> p;
            // 获取估计大小
            int s = getEst();
            // 集合估计长度大于1 且当前节点不为null
            if (s > 1 && (p = current) != null) {
                // 获取拆分位置
                int n = batch + BATCH_UNIT;
                // 拆分位置超过集合长度 拆分位置为集合长度
                if (n > s)
                    n = s;
                // 如果拆分位置大于最大批量数 则拆分位置为最大批量数
                if (n > MAX_BATCH)
                    n = MAX_BATCH;
                // 创建数组
                Object[] a = new Object[n];
                int j = 0;
                // 循环数组赋值
                do {
                    a[j++] = p.item;
                } while ((p = p.next) != null && j < n);
                // 修改当节点
                current = p;
                // 修改批次位置
                batch = j;
                // 估计大小
                est = s - j;
                // 使用Spliterators实现拆分迭代器
                return Spliterators.spliterator(a, 0, j, Spliterator.ORDERED);
            }
            return null;
        }

        /**
         * 循环执行操作
         * @param action
         */
        public void forEachRemaining(Consumer<? super E> action) {
            // 当前节点
            Node<E> p;
            // 估计大小
            int n;
            // 操作不能为null
            if (action == null) throw new NullPointerException();
            if ((n = getEst()) > 0 && (p = current) != null) {
                // 默认循环结束 当前节点为null 估计大小为0
                current = null;
                est = 0;
                // 循环执行操作
                do {
                    E e = p.item;
                    p = p.next;
                    // 循环操作
                    action.accept(e);
                } while (p != null && --n > 0);
            }
            // 修改检查
            if (list.modCount != expectedModCount)
                throw new ConcurrentModificationException();
        }

        // 对当前节点元素元素进行操作
        public boolean tryAdvance(Consumer<? super E> action) {
            // 当前节点
            Node<E> p;
            // 操作不能为null
            if (action == null) throw new NullPointerException();
            // 估计大小大于0且当前节点不能为null
            if (getEst() > 0 && (p = current) != null) {
                // 估计大小自减
                --est;
                // 获取当前节点元素
                E e = p.item;
                //当前几点后移
                current = p.next;
                // 执行操作
                action.accept(e);
                // 修改检查
                if (list.modCount != expectedModCount)
                    throw new ConcurrentModificationException();
                return true;
            }
            return false;
        }

        // 获取元素特征值
        // ORDERED 元素之间是有顺序的
        // SIZED 表示长度为有限个
        // SUBSIZED 迭代器所分割得到的子迭代器也是有序的
        public int characteristics() {
            return Spliterator.ORDERED | Spliterator.SIZED | Spliterator.SUBSIZED;
        }
    }

}
